package nl.jteam.jsa.core;

import java.util.Map;

/**
 * Represents a search query. This query can carry free text query and field filters. It also defines pagination
 * attributes to limit the number of search results.
 *
 * @author Uri Boness
 */
public interface SearchQuery {

    /**
     * Returns the maximum number of hits that should be returned when searching (the page size/capacity).
     *
     * @return The maximum number of hits that should be returned when searching.
     */
    int getPageSize();

    /**
     * Returns the index of the returned hits page.
     *
     * @return The index of the returned hits page.
     */
    int getPageIndex();

}

